2.6.3. Query String parameters

[!NOTE] Query parameters are similar to /sales invoice.

Parameter	Description	Type
documentID	The invoice code (optional)	Integer
documentExtID	The account code in the external system (optional)	integer
docTime	Date and time of document creation, format: yyyy-MM-dd hh:mm:ss(if passed, the system checks the uniqueness by the totality of fields: docTime + docNumber + amount; if such a document has already been fiscalized, then reprinting is performed without fiscalization) (optional)	String
docNumber	Document number in the accounting system	String
wsName	Number of the cash register to be printed on the check (optional)	String
departmentName	Store name to be printed on the receipt (optional)	String
departmentCode	Point of sale code with multimerchant system (optional)	String
employeeName	Stcashier's full name	String
amount	Document amount in kopecks	String
currency	Currency name	String
items: {…}	List of goods/services on the invoice	Array
payments: {…}	Payment block	Array
extraPayments: {…}	Additional payment types array	Array
fiscalID	Fiscal code of the document if the document was fiscalized (for reprint)	String
printFooter	Arbitrary lines to print at the end of the receipt (optional)	String
creditContract	Credit agreement number (mandatory when paying by credit)	String
prepayDocID	Fiscal prepayment check code (mandatory when using prepayment)	String
prepayDocNum	Prepay check number (optional)	String
clientPhone	Client phone number (optional)	String
clientName	Client name (optional)	String
tips	Tip amount in kopecks (optional)	Integer
cashback	cashback amount in kopecks (optional)	Integer
skipReceiptPrint	Do not print terminal receipts when paying by card (optional)	Boolean

items {…} Array

Field	Description	Type
itemId	Product/Service code in the accounting system	String
itemCodeType	Type of Product/Service code in the accounting system (optional)
itemName	Product/Service name	String
itemAttr	Ext. Attributes by position (1 - prepaid service) (optional)	Integer
itemQRCode	QR code product identification systems (optional) (If the quantity (Qty) is greater than 1, the items should be listed separated by a semicolon ";")	String
itemCode	External code, classification (optional)
itemUnitCode	External packaging code (optional)
itemUnitId	Unit Code of measure (optional)
itemUnit	Unit of measure (optional)
itemBarcode	Item barcod (optional)
itemQty	Qty*1000	Integer
itemAmount	Amount to be paid in kopecks	Integer
discount	Discount amount in kopecks (optional)	Integer
discountPrc	discount percentage (optional)	Numeric
extraData	Additional data, purpose depends on OFD (optional)	String
textToPrint	Arbitrary text that will be printed after this position on the receipt	String
itemTaxes: {…}	List of taxes by item	Array
itemMarginSum	The amount of the margin part in kopecks that is taxable in accordance with the percentage of taxation, while part cost price is not taxed (optional)	Integer
itemMarginPrice	Margin price (optional)

[!NOTE] If the tax calculation by the trade-markup system is not used, the itemMarginPrice and itemMarginSum parameters should be omitted (or passed as null).

itemTaxes {…} Array

Field	Description	Type
taxName	Tax name (required if not used taxCode)	String
fullName	The full name of the tax (including the percentage), (required if not used taxCode); By default, the receipt will print taxName + taxPrc	String
taxCode	Tax symbol (recommended)	String
taxPrc	Tax percentage*100 (required if not used taxCode)	Integer
calcType	Tax calculation type (required if not used taxCode), possible values: 1 – including, 2 - fixed (excise amount*number of goods), 3 - simplified (percentage of the sale amount), Default value - 1	Integer

payments {…} Array

Field	Description	Type
cashAmount	Cash payment amount in kopecks	Integer
cashlessAmount	The amount of payment without cash in kopecks	Integer
creditAmount	Credit amount in kopecks	Integer
bonusesAmount	Bonus payment amount in kopecks	Integer
prepaymentAmount	Prepayment amount in kopecks	Integer
prepaymentCashlessAmount	Cashless prepayment amount in kopecks (optional)	Integer
installmentAmount	Installment amount in kopecks	Integer
invoiceAmount	The amount of non-cash payment without contacting the payment application in kopecks	Integer
rrn	Transaction number when paying by credit card	String
cardNumber	Number of the card used to make the payment	String
bankName	Bank name (optional)	String

extraPayments {…} Array

Field	Description	Type
code	Payment type code	String
amount	Payment amount in kopecks	Integer
trxParams	Additional parameters for card payment transactions	json

Query String structure:

{
  "documentID": "integer, account code (optional)",
  "documentExtID": "integer, account code in the external system (optional)",
  "docTime": "string, document creation date and time, format: yyyy-MM-dd hh:mm:ss (optional; if provided, the system checks uniqueness by docTime+docNumber+amount and returns existing document without fiscalization if already processed)",
  "docNumber": "string, document number in the accounting system",
  "wsName": "string, cash register number for printing on the receipt (optional)",
  "departmentName": "string, store name for printing on the receipt (optional)",
  "departmentCode": "string, point-of-sale code in a multi-merchant system (optional)",
  "employeeName": "string, cashier’s full name",
  "amount": "integer, document amount in kopecks",
  "currency": "string, currency name",
  "items": [
    {
      "itemId": "string, product/service code in the accounting system",
      "itemCodeType": "string, type of product/service code in the accounting system (optional)",
      "itemName": "string, product/service name",
      "itemAttr": "integer, additional attributes for the line (1 – prepaid service) (optional)",
      "itemQRCode": "string, QR code for product identification (optional; semicolon-delimited)",
      "itemCode": "string, external or classification code (optional)",
      "itemUnitCode": "string, external packaging code (optional)",
      "itemUnitId": "string, unit-of-measure code (optional)",
      "itemUnit": "string, unit of measure (optional)",
      "itemBarcode": "string, product barcode (optional)",
      "itemQty": "integer, quantity × 1000",
      "itemAmount": "integer, amount to be paid in kopecks",
      "discount": "integer, discount amount in kopecks (optional)",
      "discountPrc": "numeric, discount percentage (optional)",
      "extraData": "string, additional data (purpose depends on OFD) (optional)",
      "textToPrint": "string, arbitrary text to print after this line on the receipt (optional)",
      "itemTaxes": [
        {
          "taxName": "string, tax name",
          "fullName": "string, full tax name with percentage (optional; defaults to taxName + taxPrc on receipt)",
          "taxCode": "string, symbolic tax code (optional)",
          "taxPrc": "integer, tax percentage × 100",
          "calcType": "integer, tax calculation type (1 – inclusive, 2 – fixed excise, 3 – simplified percentage) (default: 1)"
        }
      ],
      "itemMarginSum": "integer, taxable margin amount in kopecks (optional)",
      "itemMarginPrice": "integer, margin unit price (optional)"
    }
  ],
  "payments": {
    "cashAmount": "integer, cash payment amount in kopecks",
    "cashlessAmount": "integer, non-cash payment amount in kopecks",
    "creditAmount": "integer, credit payment amount in kopecks",
    "bonusesAmount": "integer, bonuses payment amount in kopecks",
    "prepaymentAmount": "integer, prepayment amount in kopecks",
    "prepaymentCashlessAmount": "integer, non-cash prepayment amount in kopecks (optional)",
    "installmentAmount": "integer, installment payment amount in kopecks",
    "invoiceAmount": "integer, non-cash payment without invoking the payment application in kopecks",
    "rrn": "string, transaction reference number for card payment",
    "cardNumber": "string, card number used for payment",
    "bankName": "string, bank name (optional)"
  },
  "extraPayments": [
    {
      "code": "string, payment type code",
      "amount": "integer, payment amount in kopecks",
      "trxParams": "json, additional parameters for card payment"
    }
  ],
  "fiscalID": "string, fiscal document code if the document was fiscalized (for reprinting)",
  "printFooter": "string, arbitrary lines to print at the end of the receipt (optional)",
  "creditContract": "string, credit agreement number (required for credit payment)",
  "prepayDocID": "string, fiscal code of the prepayment receipt (required when using prepayment)",
  "prepayDocNum": "string, prepayment receipt number (optional)",
  "clientPhone": "string, client’s phone number (optional)",
  "clientName": "string, client’s name (optional)",
  "tips": "integer, tip amount in kopecks (optional)",
  "cashback": "integer, cashback amount in kopecks (optional)",
  "skipReceiptPrint": "boolean, do not print terminal receipts for card payments (optional)"
}